Skip to content

[Chore] Validate API key in the init flow #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 19, 2025
Merged

[Chore] Validate API key in the init flow #932

merged 1 commit into from
Nov 19, 2025

Conversation

@HeshamHM28
Copy link
Contributor

@HeshamHM28 HeshamHM28 commented Nov 19, 2025 •
edited by github-actions bot
Loading

User description

fixes CF-864

PR Type

Bug fix, Enhancement

Description

  • Validate API key during init flow

  • Import and call get_user_id for verification

  • Preserve existing API key save behavior

Diagram Walkthrough

flowchart LR
  init["init flow"] --> prompt["Prompt for API key"]
  prompt --> verify["Call get_user_id(api_key)"]
  verify -- "valid" --> save["Save API key to rc"]
  verify -- "invalid (raises)" --> exit["apologize_and_exit / error"]
Loading

File Walkthrough
Relevant files
Enhancement
cmd_init.py
Add API key validation via get_user_id                                     

codeflash/cli_cmds/cmd_init.py

  • Import get_user_id from codeflash.api.cfapi.
  • Call get_user_id(api_key) before saving key to rc.
  • Use call as validation step in init flow.
 +2/-1     

@github-actions
Copy link

github-actions bot commented Nov 19, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Error Handling

Calling get_user_id(api_key=api_key) for validation may raise and terminate the flow without a user-friendly message or cleanup. Ensure exceptions are caught and routed through apologize_and_exit with actionable feedback.

 
get_user_id(api_key=api_key)  # Used to verify whether the API key is valid.
result = save_api_key_to_rc(api_key)
if is_successful(result):
UX Messaging

If validation fails, consider informing the user before/without saving, and differentiate messages for invalid vs. network errors to avoid confusion.

 
get_user_id(api_key=api_key)  # Used to verify whether the API key is valid.
result = save_api_key_to_rc(api_key)
if is_successful(result):
    click.echo(result.unwrap())
else:

@github-actions
Copy link

github-actions bot commented Nov 19, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Gate saving on validation success

Ensure the API key is only saved after successful validation. If validation fails,
abort without persisting the invalid key to the user's shell rc file.

codeflash/cli_cmds/cmd_init.py [1219-1221]

-get_user_id(api_key=api_key)  # Used to verify whether the API key is valid.
+user_id = None
+try:
+    user_id = get_user_id(api_key=api_key)
+except Exception:
+    pass
+if not user_id:
+    apologize_and_exit("API key validation failed; not saving the key.")
+
 result = save_api_key_to_rc(api_key)
Suggestion importance[1-10]: 8

__

Why: Ensuring the key is only saved after successful validation prevents persisting invalid credentials, directly improving correctness of the init flow. This tightly aligns with the new validation call and has meaningful impact.

Medium
Validate and guard API key call

Handle potential exceptions or invalid responses from get_user_id to prevent the
init flow from crashing on bad or expired keys. Provide a clear user-facing message
and exit early before writing the key.

codeflash/cli_cmds/cmd_init.py [1219]

-get_user_id(api_key=api_key)  # Used to verify whether the API key is valid.
+try:
+    user_id = get_user_id(api_key=api_key)  # Used to verify whether the API key is valid.
+    if not user_id:
+        apologize_and_exit("The provided API key appears invalid. Please double-check and try again.")
+except Exception:
+    apologize_and_exit("Failed to validate API key. Please check your network connection and try again.")
Suggestion importance[1-10]: 7

__

Why: Adding exception handling and checking the result of get_user_id prevents crashes and provides clearer feedback, improving robustness before proceeding. It's contextually accurate, though it's an error-handling enhancement rather than a critical bug fix.

Medium

aseembits93
aseembits93 reviewed Nov 19, 2025
View reviewed changes
codeflash/cli_cmds/cmd_init.py
# On Windows, create a batch file in the user's home directory (not auto-run, just used to store api key)
shell_rc_path.touch()
click.echo(f"✅ Created {shell_rc_path}")
get_user_id(api_key=api_key) # Used to verify whether the API key is valid.
Copy link
Contributor

@aseembits93 aseembits93 Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HeshamHM28 how are you using the result of get_user_id?

Copy link
Contributor Author

@HeshamHM28 HeshamHM28 Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inside get_user_id, if the API key is invalid, we log ‘Invalid Codeflash API key’ and exit. Screenshot 2025-11-19 at 9 15 08 PM

@aseembits93 aseembits93 merged commit 0168944 into main Nov 19, 2025
23 checks passed
@aseembits93 aseembits93 deleted the chore/add/apikey/Validation branch November 19, 2025 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aseembits93 aseembits93 aseembits93 approved these changes

Assignees

No one assigned

Labels

Review effort 2/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@HeshamHM28 @aseembits93